// Copyright (c) 2024, BlockProject 3D

//

// All rights reserved.

//

// Redistribution and use in source and binary forms, with or without modification,

// are permitted provided that the following conditions are met:

//

//     * Redistributions of source code must retain the above copyright notice,

//       this list of conditions and the following disclaimer.

//     * Redistributions in binary form must reproduce the above copyright notice,

//       this list of conditions and the following disclaimer in the documentation

//       and/or other materials provided with the distribution.

//     * Neither the name of BlockProject 3D nor the names of its contributors

//       may be used to endorse or promote products derived from this software

//       without specific prior written permission.

//

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR

// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use crate::compiler::Protocol;

use crate::gen::codec::CodecMap;

use crate::gen::file::File;

use itertools::Itertools;

use std::path::Path;

pub trait Generator {

    type Error: std::error::Error;

    type Params<'a>;

    fn get_default_codecs<'fragment, 'variable>() -> CodecMap<'fragment, 'variable> {

        CodecMap::default()

    }

    fn generate(proto: &Protocol, codec_map: &CodecMap, params: &Self::Params<'_>) -> Result<Vec<File>, Self::Error>;

    fn generate_umbrella<'a>(

        _: &str,

        _: impl Iterator<Item = &'a Path>,

        _: &Self::Params<'_>,

    ) -> Result<String, Self::Error> {

        Ok(String::new())

    }

    fn generate_file_header<'a>(lines: impl Iterator<Item = &'a str>) -> String {

        lines.map(|v| String::from("// ") + v).join("\n") + "\n\n"

    }

    fn get_language_extension() -> &'static str;

}